docs: migrate missing HAMi docs to website (Phase 1, closes #422) by mesutoezdil · Pull Request #423 · Project-HAMi/website

mesutoezdil · 2026-05-28T15:04:34Z

Migrates 11 documents from HAMi/HAMi docs/ that were absent from the website. Each document is adapted to Docusaurus format with proper frontmatter and heading structure. Chinese translations are included for files that had source CN versions.

New pages added:

userguide/benchmark - GPU sharing performance benchmarks (vLLM, Qwen3-8B)
userguide/nvidia-device/scheduling-policy - binpack / spread / numa-first scheduling policies
developers/profiling-scheduler - pprof-based scheduler profiling guide
developers/scheduler-event-log - improved scheduler event/log observability proposal
developers/gpu-topology-scheduling - topology-aware GPU scheduling (merged from nvidia-gpu-topology-scheduler.md + gpu-topo-policy.md)
developers/gpu-utilization-metrics - per-pod vGPU utilization metrics design (translated from CN)
developers/hami-vnpu-core-integration - Ascend vNPU core integration design (translated from CN)
contributor/roadmap - hardware support matrix and planned features
contributor/e2e-testing - E2E testing proposal and Ginkgo framework
static/grafana/gpu-dashboard.json - Grafana dashboard template

i18n (zh) versions added for:

userguide/benchmark
developers/profiling-scheduler
developers/gpu-topology-scheduling

sidebars.js updated to include all new pages in appropriate sections.

What is not included

Phase 2 (deleting duplicate files from HAMi/HAMi docs/) - that requires a separate PR to the HAMi main repository.
Benchmark chart images - the source images were not present in the HAMi repo at the time of migration.

cc @rootsongjc

…AMi#422) Migrates 11 documents from HAMi/HAMi docs/ that were absent from the website, adapts each to Docusaurus format, adds sidebar entries, and includes Chinese translations where source files existed. New pages: - userguide/benchmark - GPU sharing performance benchmarks (vLLM) - userguide/nvidia-device/scheduling-policy - binpack/spread/numa-first - developers/profiling-scheduler - pprof-based scheduler profiling - developers/scheduler-event-log - improved event/log observability design - developers/gpu-topology-scheduling - topology-aware scheduling guide - developers/gpu-utilization-metrics - per-pod vGPU utilization metrics - developers/hami-vnpu-core-integration - Ascend vNPU core integration - contributor/roadmap - hardware support matrix and planned features - contributor/e2e-testing - E2E testing proposal and framework - static/grafana/gpu-dashboard.json - Grafana dashboard template Chinese (i18n/zh) versions added for benchmark, profiling-scheduler, and gpu-topology-scheduling. CN-only proposals translated to English. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>

netlify · 2026-05-28T15:04:41Z

✅ Deploy Preview for project-hami ready!

Name	Link
🔨 Latest commit	`3bf6fdc`
🔍 Latest deploy log	https://app.netlify.com/projects/project-hami/deploys/6a185e2e7cb1ba00087ab396
😎 Deploy Preview	https://deploy-preview-423--project-hami.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
🤖 Make changes	Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>

…ct-HAMi#422) Replaces all GitHub raw URLs pointing to deleted HAMi docs/ files with self-hosted assets or correct website paths. Covers docs/, blog/, versioned_docs/, and all i18n/zh/ equivalents. Image changes: - Download hami-dynamic-mig-structure.png and hami-dynamic-mig-procedure.png to static/img/docs/en/dynamic-mig/ and update all dynamic-mig.md refs - Download flowchart.jpeg to static/img/blog/ and update blog post ref Link changes: - docs/config.md -> /docs/userguide/configure - docs/dynamic-mig-support.md -> /docs/userguide/nvidia-device/dynamic-mig-support - docs/develop/design.md -> /docs/developers/hami-core-design (via website) - docs/benchmark_cn.md -> /docs/userguide/benchmark - docs/proposals/resource-interpreter-webhook (never existed) -> prose note Applied across: CHANGELOG.md, docs/, blog/, versioned_docs/ (all versions), i18n/zh/docusaurus-plugin-content-docs/, i18n/zh/docusaurus-plugin-content-blog/, and i18n/zh/docusaurus-plugin-content-blog-changelog/. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>

windsonsea · 2026-05-29T07:00:32Z

/approve

hami-robot · 2026-05-29T07:00:38Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mesutoezdil, windsonsea

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [windsonsea]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

windsonsea · 2026-05-29T07:01:26Z

Issue 1 - Missing Grafana Dashboard JSON:

File docs/userguide/monitoring/grafana-dashboard.md (line 13) references /grafana/gpu-dashboard.json but this JSON file is not included in the PR. Please either:

Add the file to static/grafana/gpu-dashboard.json, or
Link to an external source

windsonsea · 2026-05-29T07:01:31Z

Issue 2 - Missing Flowchart Image:

File blog/2024-12-31-post/index.md (line 24) was changed from:

Original: https://github.com/Project-HAMi/HAMi/blob/master/docs/develop/imgs/flowchart.jpeg?raw=true
New: /img/blog/flowchart.jpeg

The image file /img/blog/flowchart.jpeg is not included in this PR. Please either:

Add the image file to static/img/blog/flowchart.jpeg, or
Keep the original GitHub URL

mesutoezdil · 2026-05-29T07:05:09Z

Thanks for the review, @windsonsea!

Both files are already included in this PR:

Issue 1 - Grafana Dashboard JSON:
static/grafana/gpu-dashboard.json (41KB) was added in commit c60045b (Phase 1). It is present in the PR diff under the static/grafana/ directory.

Issue 2 - Flowchart Image:
static/img/blog/flowchart.jpeg (45KB) was added in commit 3bf6fdc (Phase 3). The blog post change and the image file are in the same commit.

The PR has 53 changed files across 3 commits - it is possible they were easy to miss given the size/XXL scope. Let me know if you can verify on the deploy preview: https://deploy-preview-423--project-hami.netlify.app

windsonsea · 2026-05-29T07:07:23Z

/lgtm

All documentation previously living in docs/ has either been fully migrated to the official website (https://project-hami.io) or moved to a more appropriate location in this repo. The website is now the single source of truth for HAMi user and developer documentation. Deleted (Category 1 - already had equivalents on website): - Device support guides: cambricon, hygon, iluvatar, metax, mthreads, kunlunxin, vastai, enflame-gcu, enflame-vgcu, ascend910b, ascend910-hami-vnpu-core (including all _cn.md pairs) - Installation guides: offline-install, how-to-use-volcano-vgpu, how-to-use-volcano-ascend (including _cn.md pairs) - Configuration and feature docs: config, dashboard, dynamic-mig-support, resource-quota (including _cn.md pairs) - Developer internals: develop/design, develop/protocol, develop/dynamic-mig, develop/scheduler-policy, develop/imgs/ - Historical: CHANGELOG/CHANGELOG-0.0.0.md, mind-map/ Deleted (Category 2 - migrated to website in Project-HAMi/website#423): - benchmark, benchmark_cn - scheduling-policy - how-to-profiling-scheduler, how-to-profiling-scheduler_cn - scheduler-event-log, gpu-dashboard.json - develop/roadmap - proposals/ (nvidia-gpu-topology-scheduler, gpu-topo-policy, e2e_test, gpu_utilization_cn, integrating_hami_vnpu_core_for_virtualization_cn) and related images Moved (Category 3 - internal, not user-facing): - docs/release-process.md -> .github/release-process.md Kept in docs/ (Category 3 - internal references): - docs/audit-report-v290.md - docs/general-technical-review.md Closes Project-HAMi#422 (Phase 2) Signed-off-by: mesutoezdil <mesudozdil@gmail.com>

hami-robot Bot added the dco-signoff: yes label May 28, 2026

hami-robot Bot requested review from archlitchi and windsonsea May 28, 2026 15:04

hami-robot Bot added the size/XXL label May 28, 2026

docs: add Grafana dashboard page linking gpu-dashboard.json

a3996a5

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>

mesutoezdil mentioned this pull request May 28, 2026

docs: remove legacy docs/ content superseded by project-hami/website Project-HAMi/HAMi#1913

Merged

hami-robot Bot added the approved label May 29, 2026

hami-robot Bot assigned windsonsea May 29, 2026

hami-robot Bot added the lgtm label May 29, 2026

hami-robot Bot merged commit 3ee87d1 into Project-HAMi:master May 29, 2026
11 checks passed

mesutoezdil deleted the feat/migrate-hami-docs-phase1 branch July 12, 2026 21:24

Navigation Menu

Uh oh!

docs: migrate missing HAMi docs to website (Phase 1, closes #422) - #423

docs: migrate missing HAMi docs to website (Phase 1, closes #422)#423
hami-robot[bot] merged 3 commits into
Project-HAMi:masterfrom
mesutoezdil:feat/migrate-hami-docs-phase1

mesutoezdil commented May 28, 2026 •

edited

Loading

Uh oh!

netlify Bot commented May 28, 2026 •

edited

Loading

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

hami-robot Bot commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

mesutoezdil commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mesutoezdil commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What is not included

Uh oh!

netlify Bot commented May 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for project-hami ready!

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

hami-robot Bot commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

mesutoezdil commented May 29, 2026

Uh oh!

windsonsea commented May 29, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mesutoezdil commented May 28, 2026 •

edited

Loading

netlify Bot commented May 28, 2026 •

edited

Loading